<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ClaraGenomicsAnalysis: Internal logging package</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">ClaraGenomicsAnalysis
   &#160;<span id="projectnumber">0.4.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Internal logging package</div>  </div>
</div><!--header-->
<div class="contents">

<p>Base docs for the logging package This package makes use of SpdLog under the following license:  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaa5ad054c234291111ca2a78bb41946d7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__logging.html#gaa5ad054c234291111ca2a78bb41946d7">CGA_LOG_DEBUG</a>(...)&#160;&#160;&#160;SPDLOG_DEBUG(__VA_ARGS__)</td></tr>
<tr class="memdesc:gaa5ad054c234291111ca2a78bb41946d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Log at debug level.  <a href="group__logging.html#gaa5ad054c234291111ca2a78bb41946d7">More...</a><br /></td></tr>
<tr class="separator:gaa5ad054c234291111ca2a78bb41946d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6f79986ffd118b37941ef4d3cc4bd1f7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__logging.html#ga6f79986ffd118b37941ef4d3cc4bd1f7">CGA_LOG_INFO</a>(...)&#160;&#160;&#160;SPDLOG_INFO(__VA_ARGS__)</td></tr>
<tr class="memdesc:ga6f79986ffd118b37941ef4d3cc4bd1f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Log at info level.  <a href="group__logging.html#ga6f79986ffd118b37941ef4d3cc4bd1f7">More...</a><br /></td></tr>
<tr class="separator:ga6f79986ffd118b37941ef4d3cc4bd1f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa97f13dd6ae075b35ca3f01a667d9d83"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__logging.html#gaa97f13dd6ae075b35ca3f01a667d9d83">CGA_LOG_WARN</a>(...)&#160;&#160;&#160;SPDLOG_WARN(__VA_ARGS__)</td></tr>
<tr class="memdesc:gaa97f13dd6ae075b35ca3f01a667d9d83"><td class="mdescLeft">&#160;</td><td class="mdescRight">Log at warning level.  <a href="group__logging.html#gaa97f13dd6ae075b35ca3f01a667d9d83">More...</a><br /></td></tr>
<tr class="separator:gaa97f13dd6ae075b35ca3f01a667d9d83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacd5f9588e4976ef45d2ddece37b78003"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__logging.html#gacd5f9588e4976ef45d2ddece37b78003">CGA_LOG_ERROR</a>(...)&#160;&#160;&#160;SPDLOG_ERROR(__VA_ARGS__)</td></tr>
<tr class="memdesc:gacd5f9588e4976ef45d2ddece37b78003"><td class="mdescLeft">&#160;</td><td class="mdescRight">Log at error level.  <a href="group__logging.html#gacd5f9588e4976ef45d2ddece37b78003">More...</a><br /></td></tr>
<tr class="separator:gacd5f9588e4976ef45d2ddece37b78003"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1c62d5c4d4176bc022cee9d01559252c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__logging.html#ga1c62d5c4d4176bc022cee9d01559252c">CGA_LOG_CRITICAL</a>(...)&#160;&#160;&#160;SPDLOG_CRITICAL(__VA_ARGS__)</td></tr>
<tr class="memdesc:ga1c62d5c4d4176bc022cee9d01559252c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Log at fatal/critical error level (does NOT exit)  <a href="group__logging.html#ga1c62d5c4d4176bc022cee9d01559252c">More...</a><br /></td></tr>
<tr class="separator:ga1c62d5c4d4176bc022cee9d01559252c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gaa716171cacca628efa44969863d3c43b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__logging.html#gaa716171cacca628efa44969863d3c43b">claragenomics::logging::LoggingStatus</a> { <a class="el" href="group__logging.html#ggaa716171cacca628efa44969863d3c43ba260ca9dd8a4577fc00b7bd5810298076">claragenomics::logging::LoggingStatus::success</a> = 0, 
<a class="el" href="group__logging.html#ggaa716171cacca628efa44969863d3c43baac1f4cf357f10c246b3baf4249a5bf54">claragenomics::logging::LoggingStatus::cannot_open_file</a>, 
<a class="el" href="group__logging.html#ggaa716171cacca628efa44969863d3c43bafe21a9d225faf6903e465fdda696c8ee">claragenomics::logging::LoggingStatus::cannot_open_stdout</a>
 }</td></tr>
<tr class="separator:gaa716171cacca628efa44969863d3c43b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga1e6ecad63f4d5d90cc01578f653f6e94"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__logging.html#gaa716171cacca628efa44969863d3c43b">LoggingStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__logging.html#ga1e6ecad63f4d5d90cc01578f653f6e94">claragenomics::logging::Init</a> (const char *filename=nullptr)</td></tr>
<tr class="separator:ga1e6ecad63f4d5d90cc01578f653f6e94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga848bc3ae40b237ab46ae622aadab26a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__logging.html#gaa716171cacca628efa44969863d3c43b">LoggingStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__logging.html#ga848bc3ae40b237ab46ae622aadab26a5">claragenomics::logging::SetHeader</a> (bool logTime, bool logLocation)</td></tr>
<tr class="separator:ga848bc3ae40b237ab46ae622aadab26a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga14a9230fa7689844bc29e62fd7876eb7"><td class="memItemLeft" align="right" valign="top"><a id="ga14a9230fa7689844bc29e62fd7876eb7"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__logging.html#ga14a9230fa7689844bc29e62fd7876eb7">cga_log_level_debug</a>&#160;&#160;&#160;0</td></tr>
<tr class="memdesc:ga14a9230fa7689844bc29e62fd7876eb7"><td class="mdescLeft">&#160;</td><td class="mdescRight">DEBUG log level. <br /></td></tr>
<tr class="separator:ga14a9230fa7689844bc29e62fd7876eb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga321f76f905e1c818a10cf1e940abd03a"><td class="memItemLeft" align="right" valign="top"><a id="ga321f76f905e1c818a10cf1e940abd03a"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__logging.html#ga321f76f905e1c818a10cf1e940abd03a">cga_log_level_info</a>&#160;&#160;&#160;1</td></tr>
<tr class="memdesc:ga321f76f905e1c818a10cf1e940abd03a"><td class="mdescLeft">&#160;</td><td class="mdescRight">INFO log level. <br /></td></tr>
<tr class="separator:ga321f76f905e1c818a10cf1e940abd03a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga36b5f600259d04034c356f846ae366a6"><td class="memItemLeft" align="right" valign="top"><a id="ga36b5f600259d04034c356f846ae366a6"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__logging.html#ga36b5f600259d04034c356f846ae366a6">cga_log_level_warn</a>&#160;&#160;&#160;2</td></tr>
<tr class="memdesc:ga36b5f600259d04034c356f846ae366a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">WARN log level. <br /></td></tr>
<tr class="separator:ga36b5f600259d04034c356f846ae366a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga917e85b070898893ee342e0812a9fd6c"><td class="memItemLeft" align="right" valign="top"><a id="ga917e85b070898893ee342e0812a9fd6c"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__logging.html#ga917e85b070898893ee342e0812a9fd6c">cga_log_level_error</a>&#160;&#160;&#160;3</td></tr>
<tr class="memdesc:ga917e85b070898893ee342e0812a9fd6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">ERROR log level. <br /></td></tr>
<tr class="separator:ga917e85b070898893ee342e0812a9fd6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5779f5f2d3747c5c3ec30aa4c9342852"><td class="memItemLeft" align="right" valign="top"><a id="ga5779f5f2d3747c5c3ec30aa4c9342852"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__logging.html#ga5779f5f2d3747c5c3ec30aa4c9342852">cga_log_level_critical</a>&#160;&#160;&#160;4</td></tr>
<tr class="memdesc:ga5779f5f2d3747c5c3ec30aa4c9342852"><td class="mdescLeft">&#160;</td><td class="mdescRight">CRITICAL log level. <br /></td></tr>
<tr class="separator:ga5779f5f2d3747c5c3ec30aa4c9342852"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad50582aec0df264e95e750f725ce67c7"><td class="memItemLeft" align="right" valign="top"><a id="gad50582aec0df264e95e750f725ce67c7"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__logging.html#gad50582aec0df264e95e750f725ce67c7">cga_log_level_off</a>&#160;&#160;&#160;5</td></tr>
<tr class="memdesc:gad50582aec0df264e95e750f725ce67c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">No logging. <br /></td></tr>
<tr class="separator:gad50582aec0df264e95e750f725ce67c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga145fe89628f004a5d5c87ea51de29994"><td class="memItemLeft" align="right" valign="top"><a id="ga145fe89628f004a5d5c87ea51de29994"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__logging.html#ga145fe89628f004a5d5c87ea51de29994">CGA_LOG_LEVEL</a>&#160;&#160;&#160;<a class="el" href="group__logging.html#ga14a9230fa7689844bc29e62fd7876eb7">cga_log_level_debug</a></td></tr>
<tr class="memdesc:ga145fe89628f004a5d5c87ea51de29994"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines the logging level used in the current module. <br /></td></tr>
<tr class="separator:ga145fe89628f004a5d5c87ea51de29994"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae4fda6f71f35120e2ff48157fca961b5"><td class="memItemLeft" align="right" valign="top"><a id="gae4fda6f71f35120e2ff48157fca961b5"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__logging.html#gae4fda6f71f35120e2ff48157fca961b5">SPDLOG_ACTIVE_LEVEL</a>&#160;&#160;&#160;SPDLOG_LEVEL_DEBUG</td></tr>
<tr class="memdesc:gae4fda6f71f35120e2ff48157fca961b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set log level to DEBUG. <br /></td></tr>
<tr class="separator:gae4fda6f71f35120e2ff48157fca961b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Base docs for the logging package This package makes use of SpdLog under the following license: </p>
<p>The MIT License (MIT)</p>
<p>Copyright (c) 2016 Gabi Melman.</p>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga1c62d5c4d4176bc022cee9d01559252c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1c62d5c4d4176bc022cee9d01559252c">&#9670;&nbsp;</a></span>CGA_LOG_CRITICAL</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CGA_LOG_CRITICAL</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>...</em></td><td>)</td>
          <td>&#160;&#160;&#160;SPDLOG_CRITICAL(__VA_ARGS__)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Log at fatal/critical error level (does NOT exit) </p>
<p>parameters as per <a href="https://github.com/gabime/spdlog/blob/v1.x/README.md">https://github.com/gabime/spdlog/blob/v1.x/README.md</a> </p>

</div>
</div>
<a id="gaa5ad054c234291111ca2a78bb41946d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa5ad054c234291111ca2a78bb41946d7">&#9670;&nbsp;</a></span>CGA_LOG_DEBUG</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CGA_LOG_DEBUG</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>...</em></td><td>)</td>
          <td>&#160;&#160;&#160;SPDLOG_DEBUG(__VA_ARGS__)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Log at debug level. </p>
<p>parameters as per <a href="https://github.com/gabime/spdlog/blob/v1.x/README.md">https://github.com/gabime/spdlog/blob/v1.x/README.md</a> </p>

</div>
</div>
<a id="gacd5f9588e4976ef45d2ddece37b78003"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacd5f9588e4976ef45d2ddece37b78003">&#9670;&nbsp;</a></span>CGA_LOG_ERROR</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CGA_LOG_ERROR</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>...</em></td><td>)</td>
          <td>&#160;&#160;&#160;SPDLOG_ERROR(__VA_ARGS__)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Log at error level. </p>
<p>parameters as per <a href="https://github.com/gabime/spdlog/blob/v1.x/README.md">https://github.com/gabime/spdlog/blob/v1.x/README.md</a> </p>

</div>
</div>
<a id="ga6f79986ffd118b37941ef4d3cc4bd1f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6f79986ffd118b37941ef4d3cc4bd1f7">&#9670;&nbsp;</a></span>CGA_LOG_INFO</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CGA_LOG_INFO</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>...</em></td><td>)</td>
          <td>&#160;&#160;&#160;SPDLOG_INFO(__VA_ARGS__)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Log at info level. </p>
<p>parameters as per <a href="https://github.com/gabime/spdlog/blob/v1.x/README.md">https://github.com/gabime/spdlog/blob/v1.x/README.md</a> </p>

</div>
</div>
<a id="gaa97f13dd6ae075b35ca3f01a667d9d83"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa97f13dd6ae075b35ca3f01a667d9d83">&#9670;&nbsp;</a></span>CGA_LOG_WARN</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CGA_LOG_WARN</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>...</em></td><td>)</td>
          <td>&#160;&#160;&#160;SPDLOG_WARN(__VA_ARGS__)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Log at warning level. </p>
<p>parameters as per <a href="https://github.com/gabime/spdlog/blob/v1.x/README.md">https://github.com/gabime/spdlog/blob/v1.x/README.md</a> </p>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="gaa716171cacca628efa44969863d3c43b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa716171cacca628efa44969863d3c43b">&#9670;&nbsp;</a></span>LoggingStatus</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__logging.html#gaa716171cacca628efa44969863d3c43b">claragenomics::logging::LoggingStatus</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Logging status type </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggaa716171cacca628efa44969863d3c43ba260ca9dd8a4577fc00b7bd5810298076"></a>success&#160;</td><td class="fielddoc"><p>Success. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa716171cacca628efa44969863d3c43baac1f4cf357f10c246b3baf4249a5bf54"></a>cannot_open_file&#160;</td><td class="fielddoc"><p>Initialization could not open the output file requested. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa716171cacca628efa44969863d3c43bafe21a9d225faf6903e465fdda696c8ee"></a>cannot_open_stdout&#160;</td><td class="fielddoc"><p>Stdout could not be opened for logging. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga1e6ecad63f4d5d90cc01578f653f6e94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1e6ecad63f4d5d90cc01578f653f6e94">&#9670;&nbsp;</a></span>Init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__logging.html#gaa716171cacca628efa44969863d3c43b">LoggingStatus</a> claragenomics::logging::Init </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>filename</em> = <code>nullptr</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Init Initialize the logging </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filename</td><td>if specified, the path/name of the file into which logging should be placed. The default is stdout </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>success or error status </dd></dl>

</div>
</div>
<a id="ga848bc3ae40b237ab46ae622aadab26a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga848bc3ae40b237ab46ae622aadab26a5">&#9670;&nbsp;</a></span>SetHeader()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__logging.html#gaa716171cacca628efa44969863d3c43b">LoggingStatus</a> claragenomics::logging::SetHeader </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>logTime</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>logLocation</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>SetHeader Adjust the header/preface for each log message </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">logTime</td><td>if true, the detailed time will be prepended to each message. </td></tr>
    <tr><td class="paramname">logLocation</td><td>if true, the file and line location logging will be prepended to each message. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>success or error status </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.16
</small></address>
</body>
</html>
